<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">

<title>class ThreadGroup - RDoc Documentation</title>


<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>

<script src="./js/jquery-3.2.0.min.js"></script>

<script src="./js/vue.min.js"></script>
<script src="./js/js.cookie.min.js"></script>

<link href="./css/fonts.css" rel="stylesheet">
<link id='rdoccss' href="./css/rdoc.css" rel="stylesheet">
<link href="./css/carbon17.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "./";
  var index_rel_prefix = "./";
  var darkModeCsseHref = "./css/rdoc-dm.css"
  var defaultModeCssHref = "./css/rdoc.css"
  // var cssDarkmode = Cookies.get('darkmode');
  
  if( Cookies.get("darkmode") == "true") {
	$('#rdoccss').attr("href", darkModeCsseHref);
}

//  https://cssdeck.com/blog/simple-jquery-stylesheet-switcher/

document.write('<style type="text/css">body{display:none}</style>');

</script>


</head>
<body id="top" role="document" class="class">
  <!-- this is class.html -->

  <div id='actionbar' >
    <div class='wrapper mdiv'>
      <ul class='grids g0'></ul>
    </div> 
    <!-- VERSION HEADER for 3.3.0-preview2 NOT FOUND -->
  </div> <!-- end action bar -->

  <div class='wrapper hdiv'>

    


    <nav id='vapp' role="navigation">
    <div id="project-navigation">
      <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2><a href="./index.html" rel="home">Home</a></h2>

  <div id="table-of-contents-navigation"  >
    <a href="./table_of_contents.html#pages">Pages</a>
    <a href="./table_of_contents.html#classes">Classes</a>
    <a href="./table_of_contents.html#methods">Methods</a>
  </div>
</div>

      <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

    </div>


    

    <button id='toggleThing' @click="toggleNav()" >Show/hide navigation</button>
    <div :class="isOpen ? 'block' : 'hidden' " id='toggleMe'>
      <div id="class-metadata">
        
        
<div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

  <p class="link"><a href="Object.html">Object</a>
</div>

        
        
        
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    <li ><a href="#method-i-add">#add</a>
    <li ><a href="#method-i-enclose">#enclose</a>
    <li ><a href="#method-i-enclosed-3F">#enclosed?</a>
    <li ><a href="#method-i-list">#list</a>
  </ul>
</div>

      </div>
     </div>
    </nav>


    <div id='extraz'><div class='adzbox-index'  >
      
     </div>         
    </div>

    <main role="main" aria-labelledby="class-ThreadGroup">
    <h1 id="class-ThreadGroup" class="class">
      class ThreadGroup
    </h1>

    <section class="description">
    
<p><a href="ThreadGroup.html"><code>ThreadGroup</code></a> provides a means of keeping track of a number of threads as a group.</p>

<p>A given <a href="Thread.html"><code>Thread</code></a> object can only belong to one <a href="ThreadGroup.html"><code>ThreadGroup</code></a> at a time; adding a thread to a new group will remove it from any previous group.</p>

<p>Newly created threads belong to the same group as the thread from which they were created.</p>

    </section>

      <section id="5Buntitled-5D" class="documentation-section">


      <section class="constants-list">
      <header>
      <h3>Constants</h3>
      </header>
      <dl>
          <dt id="Default">Default
          <dd><p>The default <a href="ThreadGroup.html"><code>ThreadGroup</code></a> created when Ruby starts; all Threads belong to it by default.</p>
        </dl>
        </section>



                <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Instance Methods</h3>
                </header>

                  <div id="method-i-add" class="method-detail ">
                      <div class="method-heading">
                        <span class="method-callseq">
                          add(thread)   &rarr; thgrp
                              </span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Adds the given <code>thread</code> to this group, removing it from any other group to which it may have previously been a member.</p>

<pre class="ruby"><span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Initial group is #{ThreadGroup::Default.list}&quot;</span>
<span class="ruby-identifier">tg</span> = <span class="ruby-constant">ThreadGroup</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">t1</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> { <span class="ruby-identifier">sleep</span> }
<span class="ruby-identifier">t2</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> { <span class="ruby-identifier">sleep</span> }
<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;t1 is #{t1}&quot;</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;t2 is #{t2}&quot;</span>
<span class="ruby-identifier">tg</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">t1</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Initial group now #{ThreadGroup::Default.list}&quot;</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;tg group now #{tg.list}&quot;</span>
</pre>

<p>This will produce:</p>

<pre class="ruby"><span class="ruby-constant">Initial</span> <span class="ruby-identifier">group</span> <span class="ruby-identifier">is</span> <span class="ruby-comment">#&lt;Thread:0x401bdf4c&gt;</span>
<span class="ruby-identifier">t1</span> <span class="ruby-identifier">is</span> <span class="ruby-comment">#&lt;Thread:0x401b3c90&gt;</span>
<span class="ruby-identifier">t2</span> <span class="ruby-identifier">is</span> <span class="ruby-comment">#&lt;Thread:0x401b3c18&gt;</span>
<span class="ruby-constant">Initial</span> <span class="ruby-identifier">group</span> <span class="ruby-identifier">now</span> <span class="ruby-comment">#&lt;Thread:0x401b3c18&gt;#&lt;Thread:0x401bdf4c&gt;</span>
<span class="ruby-identifier">tg</span> <span class="ruby-identifier">group</span> <span class="ruby-identifier">now</span> <span class="ruby-comment">#&lt;Thread:0x401b3c90&gt;</span>
</pre>

                              <div class="method-source-code" id="add-source">
            <pre>static VALUE
thgroup_add(VALUE group, VALUE thread)
{
    rb_thread_t *target_th = rb_thread_ptr(thread);
    struct thgroup *data;

    if (OBJ_FROZEN(group)) {
        rb_raise(rb_eThreadError, &quot;can&#39;t move to the frozen thread group&quot;);
    }
    TypedData_Get_Struct(group, struct thgroup, &amp;thgroup_data_type, data);
    if (data-&gt;enclosed) {
        rb_raise(rb_eThreadError, &quot;can&#39;t move to the enclosed thread group&quot;);
    }

    if (OBJ_FROZEN(target_th-&gt;thgroup)) {
        rb_raise(rb_eThreadError, &quot;can&#39;t move from the frozen thread group&quot;);
    }
    TypedData_Get_Struct(target_th-&gt;thgroup, struct thgroup, &amp;thgroup_data_type, data);
    if (data-&gt;enclosed) {
        rb_raise(rb_eThreadError,
                 &quot;can&#39;t move from the enclosed thread group&quot;);
    }

    target_th-&gt;thgroup = group;
    return group;
}</pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-enclose" class="method-detail ">
                      <div class="method-heading">
                        <span class="method-callseq">
                          enclose   &rarr; thgrp
                              </span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Prevents threads from being added to or removed from the receiving <a href="ThreadGroup.html"><code>ThreadGroup</code></a>.</p>

<p>New threads can still be started in an enclosed <a href="ThreadGroup.html"><code>ThreadGroup</code></a>.</p>

<pre class="ruby"><span class="ruby-constant">ThreadGroup</span><span class="ruby-operator">::</span><span class="ruby-constant">Default</span>.<span class="ruby-identifier">enclose</span>        <span class="ruby-comment">#=&gt; #&lt;ThreadGroup:0x4029d914&gt;</span>
<span class="ruby-identifier">thr</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> { <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">stop</span> }    <span class="ruby-comment">#=&gt; #&lt;Thread:0x402a7210 sleep&gt;</span>
<span class="ruby-identifier">tg</span> = <span class="ruby-constant">ThreadGroup</span>.<span class="ruby-identifier">new</span>                <span class="ruby-comment">#=&gt; #&lt;ThreadGroup:0x402752d4&gt;</span>
<span class="ruby-identifier">tg</span>.<span class="ruby-identifier">add</span> <span class="ruby-identifier">thr</span>
<span class="ruby-comment">#=&gt; ThreadError: can&#39;t move from the enclosed thread group</span>
</pre>

                              <div class="method-source-code" id="enclose-source">
            <pre>static VALUE
thgroup_enclose(VALUE group)
{
    struct thgroup *data;

    TypedData_Get_Struct(group, struct thgroup, &amp;thgroup_data_type, data);
    data-&gt;enclosed = 1;

    return group;
}</pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-enclosed-3F" class="method-detail ">
                      <div class="method-heading">
                        <span class="method-callseq">
                          enclosed?   &rarr; true or false
                              </span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Returns <code>true</code> if the <code>thgrp</code> is enclosed. See also <a href="ThreadGroup.html#method-i-enclose"><code>ThreadGroup#enclose</code></a>.</p>

                              <div class="method-source-code" id="enclosed-3F-source">
            <pre>static VALUE
thgroup_enclosed_p(VALUE group)
{
    struct thgroup *data;

    TypedData_Get_Struct(group, struct thgroup, &amp;thgroup_data_type, data);
    return RBOOL(data-&gt;enclosed);
}</pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-list" class="method-detail ">
                      <div class="method-heading">
                        <span class="method-callseq">
                          list   &rarr; array
                              </span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Returns an array of all existing <a href="Thread.html"><code>Thread</code></a> objects that belong to this group.</p>

<pre class="ruby"><span class="ruby-constant">ThreadGroup</span><span class="ruby-operator">::</span><span class="ruby-constant">Default</span>.<span class="ruby-identifier">list</span>   <span class="ruby-comment">#=&gt; [#&lt;Thread:0x401bdf4c run&gt;]</span>
</pre>

                              <div class="method-source-code" id="list-source">
            <pre>static VALUE
thgroup_list(VALUE group)
{
    VALUE ary = rb_ary_new();
    rb_thread_t *th = 0;
    rb_ractor_t *r = GET_RACTOR();

    ccan_list_for_each(&amp;r-&gt;threads.set, th, lt_node) {
        if (th-&gt;thgroup == group) {
            rb_ary_push(ary, th-&gt;self);
        }
    }
    return ary;
}</pre>
                              </div>
                            </div>


                          </div>

                          </section>

              </section>
              </main>



            </div>  <!--  class='wrapper hdiv' -->


<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a></p>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.</p>
<p>Based on <a href="https://github.com/ged/darkfish/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>

  
    <p><p><a href="https://ruby-doc.org">Ruby-doc.org</a> is provided by <a href="https://jamesbritt.com">James Britt</a> and <a href="https://neurogami.com">Neurogami</a>.</p><p><a href="https://jamesbritt.bandcamp.com/">Maximum R+D</a>.  </p>
</p>
  
  </footer>

<script type="text/javascript">


  let ads  = $("#carbonads-container").children().detach();


  function swapMode() {
    var cookieName = 'darkmode';
    var cssDarkmode = Cookies.get(cookieName);
    console.log("***** swapMode! " + cssDarkmode + " *****");


    if (cssDarkmode == "true") {
      console.log("We have dark mode, set the css to light ...");
      $('#rdoccss').attr("href", defaultModeCssHref);
      $('#cssSelect').text("Dark mode");
      cssDarkmode = "false";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    } else {
      console.log("We not have dark mode, set the css to dark ...");
      $('#rdoccss').attr("href", darkModeCsseHref);
      $('#cssSelect').text("Light mode");
      cssDarkmode = "true";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    }

    console.log("  --------------- ");
  }


const vueCssApp = new Vue({
el: '#menubar',
data: {
isDark: false
},
methods: {
toggleClass: function(event){
this.isDark = !this.isDark;
}
}
})

const vueApp = new Vue({
el: '#vapp',
data: { 
isOpen: true
},

mounted() {
this.handleResize();
this.manage_mob_classes();
window.addEventListener('resize', this.handleResize)
//this.isOpen !=  (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},
destroyed() {
window.removeEventListener('resize', this.handleResize)
},
created() {
//manage_mob_classes();
},

methods : {
isMobile() {
  return (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},

  handleResize() {
    if (!this.isMobile()) {
      this.isOpen = window.innerWidth > 800;
    }
  },

  manage_mob_classes() {
    if (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)) {
      $("nav").addClass("mob_nav");
      $("main").addClass("mob_main");
      $("#extraz").addClass("mob_extraz");
      $("#carbonads-container").addClass("mob_carbonads-container");
      this.isOpen  = false;
    } else {
      $("nav").removeClass("mob_nav") 
        $("main").removeClass("mob_main");
      $("#extraz").removeClass("mob_extraz");
      $("#carbonads-container").removeClass("mob_carbonads-container");
      this.isOpen  = true;
    }
  },

  toggleNav() {
    this.isOpen =! this.isOpen ;
    // alert("Toggle nav!");
    console.log("toggleNav() click: " + this.isOpen );
  }
}
})

$("#carbonads-container").append(ads);


$(function() {

    var darkmode = Cookies.get("darkmode");
    console.log("Document ready: " + darkmode);

    if ( darkmode  == "true" ) {
      $('#cssSelect').text("Light mode");
    } else {
      $('#cssSelect').text("Dark mode");
     }

    $('body').css('display','block');
    });

</script>

    
  </body> 
</html>

